<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="dfareporting_v3_5.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_5.placementGroups.html">placementGroups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one placement group by ID.</p>
<p class="toc_element">
  <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new placement group.</p>
<p class="toc_element">
  <code><a href="#list">list(profileId, advertiserIds=None, archived=None, campaignIds=None, contentCategoryIds=None, directorySiteIds=None, ids=None, maxEndDate=None, maxResults=None, maxStartDate=None, minEndDate=None, minStartDate=None, pageToken=None, placementGroupType=None, placementStrategyIds=None, pricingTypes=None, searchString=None, siteIds=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of placement groups, possibly filtered. This method supports paging.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing placement group. This method supports patch semantics.</p>
<p class="toc_element">
  <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing placement group.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
  <pre>Gets one placement group by ID.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, Placement group ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;archived&quot;: True or False, # Whether this placement group is archived.
  &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement group. This field is required on insertion.
  &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;childPlacementIds&quot;: [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
    &quot;A String&quot;,
  ],
  &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement group.
  &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement group.
  &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
  &quot;id&quot;: &quot;A String&quot;, # ID of this placement group. This is a read-only, auto-generated field.
  &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placementGroup&quot;.
  &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;name&quot;: &quot;A String&quot;, # Name of this placement group. This is a required field and must be less than 256 characters long.
  &quot;placementGroupType&quot;: &quot;A String&quot;, # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
  &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement group.
  &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
    &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
    &quot;endDate&quot;: &quot;A String&quot;,
    &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
    &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
      { # Pricing Period
        &quot;endDate&quot;: &quot;A String&quot;,
        &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
        &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
        &quot;startDate&quot;: &quot;A String&quot;,
        &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
      },
    ],
    &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
    &quot;startDate&quot;: &quot;A String&quot;,
    &quot;testingStartDate&quot;: &quot;A String&quot;,
  },
  &quot;primaryPlacementId&quot;: &quot;A String&quot;, # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
  &quot;primaryPlacementIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
  <pre>Inserts a new placement group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of a package or roadblock.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;archived&quot;: True or False, # Whether this placement group is archived.
  &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement group. This field is required on insertion.
  &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;childPlacementIds&quot;: [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
    &quot;A String&quot;,
  ],
  &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement group.
  &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement group.
  &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
  &quot;id&quot;: &quot;A String&quot;, # ID of this placement group. This is a read-only, auto-generated field.
  &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placementGroup&quot;.
  &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;name&quot;: &quot;A String&quot;, # Name of this placement group. This is a required field and must be less than 256 characters long.
  &quot;placementGroupType&quot;: &quot;A String&quot;, # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
  &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement group.
  &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
    &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
    &quot;endDate&quot;: &quot;A String&quot;,
    &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
    &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
      { # Pricing Period
        &quot;endDate&quot;: &quot;A String&quot;,
        &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
        &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
        &quot;startDate&quot;: &quot;A String&quot;,
        &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
      },
    ],
    &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
    &quot;startDate&quot;: &quot;A String&quot;,
    &quot;testingStartDate&quot;: &quot;A String&quot;,
  },
  &quot;primaryPlacementId&quot;: &quot;A String&quot;, # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
  &quot;primaryPlacementIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;archived&quot;: True or False, # Whether this placement group is archived.
  &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement group. This field is required on insertion.
  &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;childPlacementIds&quot;: [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
    &quot;A String&quot;,
  ],
  &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement group.
  &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement group.
  &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
  &quot;id&quot;: &quot;A String&quot;, # ID of this placement group. This is a read-only, auto-generated field.
  &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placementGroup&quot;.
  &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;name&quot;: &quot;A String&quot;, # Name of this placement group. This is a required field and must be less than 256 characters long.
  &quot;placementGroupType&quot;: &quot;A String&quot;, # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
  &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement group.
  &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
    &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
    &quot;endDate&quot;: &quot;A String&quot;,
    &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
    &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
      { # Pricing Period
        &quot;endDate&quot;: &quot;A String&quot;,
        &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
        &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
        &quot;startDate&quot;: &quot;A String&quot;,
        &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
      },
    ],
    &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
    &quot;startDate&quot;: &quot;A String&quot;,
    &quot;testingStartDate&quot;: &quot;A String&quot;,
  },
  &quot;primaryPlacementId&quot;: &quot;A String&quot;, # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
  &quot;primaryPlacementIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(profileId, advertiserIds=None, archived=None, campaignIds=None, contentCategoryIds=None, directorySiteIds=None, ids=None, maxEndDate=None, maxResults=None, maxStartDate=None, minEndDate=None, minStartDate=None, pageToken=None, placementGroupType=None, placementStrategyIds=None, pricingTypes=None, searchString=None, siteIds=None, sortField=None, sortOrder=None, x__xgafv=None)</code>
  <pre>Retrieves a list of placement groups, possibly filtered. This method supports paging.

Args:
  profileId: string, User profile ID associated with this request. (required)
  advertiserIds: string, Select only placement groups that belong to these advertisers. (repeated)
  archived: boolean, Select only archived placements. Don&#x27;t set this field to select both archived and non-archived placements.
  campaignIds: string, Select only placement groups that belong to these campaigns. (repeated)
  contentCategoryIds: string, Select only placement groups that are associated with these content categories. (repeated)
  directorySiteIds: string, Select only placement groups that are associated with these directory sites. (repeated)
  ids: string, Select only placement groups with these IDs. (repeated)
  maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as &quot;yyyy-MM-dd&quot;.
  maxResults: integer, Maximum number of results to return.
  maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as &quot;yyyy-MM-dd&quot;.
  minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as &quot;yyyy-MM-dd&quot;.
  minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as &quot;yyyy-MM-dd&quot;.
  pageToken: string, Value of the nextPageToken from the previous result page.
  placementGroupType: string, Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.
    Allowed values
      PLACEMENT_PACKAGE - 
      PLACEMENT_ROADBLOCK - 
  placementStrategyIds: string, Select only placement groups that are associated with these placement strategies. (repeated)
  pricingTypes: string, Select only placement groups with these pricing types. (repeated)
    Allowed values
      PRICING_TYPE_CPM - 
      PRICING_TYPE_CPC - 
      PRICING_TYPE_CPA - 
      PRICING_TYPE_FLAT_RATE_IMPRESSIONS - 
      PRICING_TYPE_FLAT_RATE_CLICKS - 
      PRICING_TYPE_CPM_ACTIVEVIEW - 
  searchString: string, Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, &quot;placement*2015&quot; will return placement groups with names like &quot;placement group June 2015&quot;, &quot;placement group May 2015&quot;, or simply &quot;placements 2015&quot;. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of &quot;placementgroup&quot; will match placement groups with name &quot;my placementgroup&quot;, &quot;placementgroup 2015&quot;, or simply &quot;placementgroup&quot;.
  siteIds: string, Select only placement groups that are associated with these sites. (repeated)
  sortField: string, Field by which to sort the list.
    Allowed values
      ID - 
      NAME - 
  sortOrder: string, Order of sorted results.
    Allowed values
      ASCENDING - 
      DESCENDING - 
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Placement Group List Response
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placementGroupsListResponse&quot;.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
  &quot;placementGroups&quot;: [ # Placement group collection.
    { # Contains properties of a package or roadblock.
      &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement group. This is a read-only field that can be left blank.
      &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement group. This is a required field on insertion.
      &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
        &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
        &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
        &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
        &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
        &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
        &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
      },
      &quot;archived&quot;: True or False, # Whether this placement group is archived.
      &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement group. This field is required on insertion.
      &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
        &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
        &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
        &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
        &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
        &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
        &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
      },
      &quot;childPlacementIds&quot;: [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
        &quot;A String&quot;,
      ],
      &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement group.
      &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement group.
      &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
        &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
      },
      &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
        &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
        &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
        &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
        &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
        &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
        &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
      },
      &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
      &quot;id&quot;: &quot;A String&quot;, # ID of this placement group. This is a read-only, auto-generated field.
      &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
        &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
        &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
        &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
        &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
        &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
        &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
      },
      &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placementGroup&quot;.
      &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
        &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
      },
      &quot;name&quot;: &quot;A String&quot;, # Name of this placement group. This is a required field and must be less than 256 characters long.
      &quot;placementGroupType&quot;: &quot;A String&quot;, # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
      &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement group.
      &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
        &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
        &quot;endDate&quot;: &quot;A String&quot;,
        &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
        &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
        &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
          { # Pricing Period
            &quot;endDate&quot;: &quot;A String&quot;,
            &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
            &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
            &quot;startDate&quot;: &quot;A String&quot;,
            &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
          },
        ],
        &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
        &quot;startDate&quot;: &quot;A String&quot;,
        &quot;testingStartDate&quot;: &quot;A String&quot;,
      },
      &quot;primaryPlacementId&quot;: &quot;A String&quot;, # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
      &quot;primaryPlacementIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
        &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
        &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
        &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
        &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
        &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
        &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
      },
      &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
      &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
        &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
        &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
        &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
        &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
        &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
        &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
      },
      &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement group. This is a read-only field that can be left blank.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
  <pre>Updates an existing placement group. This method supports patch semantics.

Args:
  profileId: string, User profile ID associated with this request. (required)
  id: string, PlacementGroup ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of a package or roadblock.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;archived&quot;: True or False, # Whether this placement group is archived.
  &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement group. This field is required on insertion.
  &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;childPlacementIds&quot;: [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
    &quot;A String&quot;,
  ],
  &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement group.
  &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement group.
  &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
  &quot;id&quot;: &quot;A String&quot;, # ID of this placement group. This is a read-only, auto-generated field.
  &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placementGroup&quot;.
  &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;name&quot;: &quot;A String&quot;, # Name of this placement group. This is a required field and must be less than 256 characters long.
  &quot;placementGroupType&quot;: &quot;A String&quot;, # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
  &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement group.
  &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
    &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
    &quot;endDate&quot;: &quot;A String&quot;,
    &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
    &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
      { # Pricing Period
        &quot;endDate&quot;: &quot;A String&quot;,
        &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
        &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
        &quot;startDate&quot;: &quot;A String&quot;,
        &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
      },
    ],
    &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
    &quot;startDate&quot;: &quot;A String&quot;,
    &quot;testingStartDate&quot;: &quot;A String&quot;,
  },
  &quot;primaryPlacementId&quot;: &quot;A String&quot;, # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
  &quot;primaryPlacementIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;archived&quot;: True or False, # Whether this placement group is archived.
  &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement group. This field is required on insertion.
  &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;childPlacementIds&quot;: [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
    &quot;A String&quot;,
  ],
  &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement group.
  &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement group.
  &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
  &quot;id&quot;: &quot;A String&quot;, # ID of this placement group. This is a read-only, auto-generated field.
  &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placementGroup&quot;.
  &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;name&quot;: &quot;A String&quot;, # Name of this placement group. This is a required field and must be less than 256 characters long.
  &quot;placementGroupType&quot;: &quot;A String&quot;, # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
  &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement group.
  &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
    &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
    &quot;endDate&quot;: &quot;A String&quot;,
    &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
    &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
      { # Pricing Period
        &quot;endDate&quot;: &quot;A String&quot;,
        &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
        &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
        &quot;startDate&quot;: &quot;A String&quot;,
        &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
      },
    ],
    &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
    &quot;startDate&quot;: &quot;A String&quot;,
    &quot;testingStartDate&quot;: &quot;A String&quot;,
  },
  &quot;primaryPlacementId&quot;: &quot;A String&quot;, # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
  &quot;primaryPlacementIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}</pre>
</div>

<div class="method">
    <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
  <pre>Updates an existing placement group.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body.
    The object takes the form of:

{ # Contains properties of a package or roadblock.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;archived&quot;: True or False, # Whether this placement group is archived.
  &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement group. This field is required on insertion.
  &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;childPlacementIds&quot;: [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
    &quot;A String&quot;,
  ],
  &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement group.
  &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement group.
  &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
  &quot;id&quot;: &quot;A String&quot;, # ID of this placement group. This is a read-only, auto-generated field.
  &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placementGroup&quot;.
  &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;name&quot;: &quot;A String&quot;, # Name of this placement group. This is a required field and must be less than 256 characters long.
  &quot;placementGroupType&quot;: &quot;A String&quot;, # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
  &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement group.
  &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
    &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
    &quot;endDate&quot;: &quot;A String&quot;,
    &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
    &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
      { # Pricing Period
        &quot;endDate&quot;: &quot;A String&quot;,
        &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
        &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
        &quot;startDate&quot;: &quot;A String&quot;,
        &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
      },
    ],
    &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
    &quot;startDate&quot;: &quot;A String&quot;,
    &quot;testingStartDate&quot;: &quot;A String&quot;,
  },
  &quot;primaryPlacementId&quot;: &quot;A String&quot;, # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
  &quot;primaryPlacementIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Contains properties of a package or roadblock.
  &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement group. This is a read-only field that can be left blank.
  &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement group. This is a required field on insertion.
  &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;archived&quot;: True or False, # Whether this placement group is archived.
  &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement group. This field is required on insertion.
  &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;childPlacementIds&quot;: [ # IDs of placements which are assigned to this placement group. This is a read-only, auto-generated field.
    &quot;A String&quot;,
  ],
  &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement group.
  &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement group.
  &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
  &quot;id&quot;: &quot;A String&quot;, # ID of this placement group. This is a read-only, auto-generated field.
  &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement group. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placementGroup&quot;.
  &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement group. This is a read-only field.
    &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
  },
  &quot;name&quot;: &quot;A String&quot;, # Name of this placement group. This is a required field and must be less than 256 characters long.
  &quot;placementGroupType&quot;: &quot;A String&quot;, # Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion.
  &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement group.
  &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement group. This field is required on insertion.
    &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
    &quot;endDate&quot;: &quot;A String&quot;,
    &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
    &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
    &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
      { # Pricing Period
        &quot;endDate&quot;: &quot;A String&quot;,
        &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
        &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
        &quot;startDate&quot;: &quot;A String&quot;,
        &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
      },
    ],
    &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
    &quot;startDate&quot;: &quot;A String&quot;,
    &quot;testingStartDate&quot;: &quot;A String&quot;,
  },
  &quot;primaryPlacementId&quot;: &quot;A String&quot;, # ID of the primary placement, used to calculate the media cost of a roadblock (placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements.
  &quot;primaryPlacementIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the primary placement. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion.
  &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
    &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
    &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
    &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
    &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
    &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
    &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
  },
  &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement group. This is a read-only field that can be left blank.
}</pre>
</div>

</body></html>